Create calculated expressions

Returns the values of the periodic numeric variable in real terms. variable: a periodic numeric variable currency: an optional parameter for currency code. This should only be used if either the input or output variable is not set to default currency and should be set to the expected currency of output currency.

Example: If template currency is USD, and scalar variable is in EUR and needs to show the total for periodic variable [Var1], the expression would have these parameters: TOTAL(CONVERTTOREAL([Var1], “EUR”))

Calculates the cumulative range value of a periodic variable:

• variable: periodic variable
• start: range start period index or date
• end: range end period index or date

Example: If Var1=1,2,3,4,5 over a period 2010 to 2014.

1. Integer range parameters CUMULATIVERANGE([Var1],1,3) = null,2,5,9,null
2. Date range parameters CUMULATIVERANGE([Var1],"1/1/2011","12/1/2013") = null,2,5,9,null

Returns a specified date with the specified integer number interval added to a specified datepart of that date where:

• datepart is the part of date to which an integer number is added. The appropriate values are y, m, d which signify year, month, day, respectively.
• number is an expression that can be resolved to an integer that is added to a datepart of date.
• date is an expression that can be resolved to a date. This can either be a date variable, a string variable that can be converted to a date or text that can be converted to a date.

Example: DATEADD(“y”,1,“1 January 2010”) represents 1 January 2011.

Note: This function will not evaluate if the resultant date is less than 1 January 0001 or greater than 31 January 9999.

Compares the supplied dates and returns:

date1 > date2: -1,

date1 = date2: 0,

date1 < date2: 1

date1 and date2 can be date variables or text values. Text values will be converted to dates using the current regional settings.

Example: DATECOMPARE("1 January 2000", "1 January 2010") gets a value 1. DATECOMPARE("1 January 2010", "1 January 2000") gets a value -1.

Extracts the parts of a supplied date field and returns a number. date can be date a variable or a text value. Text value of 'date' will be converted to date using the current regional settings. datepart is: y for Year, m for Month, or d for Day. Examples:

• DATEPART("31/12/2006", "y") returns a value 2006.
• DATEPART("31/12/2006", "m") returns a value 12.
• DATEPART("31/12/2006", "d") returns a value 31.

Converts the supplied date to text. If the optional [format] argument is supplied, the date will be formatted using this exact representation, otherwise the current regional settings will be used. Examples: DATETEXT([DateVariable1]), DATETEXT([DateVariable1],““MM/dd/yyyy””).

Common format specifiers:

d day 1 - 31

dd day 01 - 31

M month 1 - 12

MM month 01 - 12

MMM abbreviated month name, e.g. Jan, Feb

MMMM full month name

yy year 00 - 99

yyyy 4-digit year

Returns the hierarchy part parsed from the supplied hierarchy location variable according to the supplied part identifier. part_id can be either the hierarchy level (0 = root node, 1 = first level, etc.), the level name (“Country”, “Region”, etc.), or a special identifier (“_last” = last node, “_parent” = parent of last node). Examples: Consider an expression is being set to the node 'CompanyName/RegionName/Consulting'.

1. GETTHEHIERARCHYPART([Hierarchy Location],2) will get the name of the node at level 2 in the hierarchy path, i.e. Consulting.

2. GETTHEHIERARCHYPART([Hierarchy Location],"Company") will get the name of the Company level node in the hierarchy path.

Using the system variable [Hierarchy Location] this function will return just the path portion of that variable.

Example: Given a node that is in the hierarchy 3 levels down, GETTHEHIERARCHYPATH ([Hierarchy Location]) will return a text representation of the names of all the nodes to traverse to get to that node, e.g. "Root Node Name\Parent Node Name\Current Node Name"

Returns the property value for the selected value from the list associated with the supplied variable at a template level. listvariable: a scalar variable with associated list property: the name of list property for the list referenced by the variable

Example: A list is created to store a list of countries with properties for notes (note) and country codes (code). List is then associated with variable CountryInfo

1. GETLISTPROPERTY("CountryInfo","note"), will get the value for the currently selected country notes

2. GETLISTPROPERTY("CountryInfo","code") will get the value of the currently selected country code, i.e.UK

Returns the periodic values of a product stream's linked price given the scenario. price: the price linked to the product selected from the Price tab in the Function Arguments section. scenario: price deck scenario name.

Example: GETPRICESCENARIODATA([Oil 1 Price],"High")

Returns data for the specified variable and scenario using the scenario tag value. scenariotag is a valid (active or inactive) scenario tag. variable is a scalar or periodic variable which is available from the list of variables.

Example: GETSCENARIODATABYTAG("Default", [Oil.Production]

Example: GETSCENARIODATABYTAG("1C",Production oil) will get the value of the variable <Production.Oil> for scenario tagged as <1C>

Returns periodic values representing the production rate of specified product of the well variable. The periodicity of the values is defined by the template. The optional date argument will offset the values to start at the specified date.

• WellVariable must be a variable with the "Well" data type.
• product must be quoted text of a defined product.
• date is an (optional) expression that can be resolved to a date. This must be a ScalarDate variable or Date function. Omitting date means the periodic values begin at the start date of the well.

Example:

1. GETWELLRATE (WellVariable,"Condensate", DATE(2016,1,1))

2. GETWELLRATE (WellVariable, "Water", ScalarDateVariable)

Returns periodic values representing the production volume of specified product of the well variable. The periodicity of the values is defined by the template. The optional date argument will offset the values to start at the specified date.

• WellVariable must be a variable with the "Well" data type.
• "Product" must be quoted text of a product defined in the Decline workspace.
• date is an (optional) expression that can be resolved to a date. This must be a ScalarDate variable or Date function. Omitting date means the periodic values begin at the start date of the well.

Example:

1. GETWELLVOLUME(WellVariable, "Condensate", DATE(2016,1,1))

2. GETWELLVOLUME(WellVariable, "Water", ScalarDateVariable)

Converts the supplied numeric representation (OLE Automation date) to a date. numeric is a supplied numeric representation (OLE Automation date). Example: NUMERICTODATE(2) gets the date 1 January 1900.

Note: The numeric value must be between -657435 to 2958466.

Returns the net present value of an investment based on a discount rate and a series of values. Discount data and method can be optionally specified to define how NPV is calculated. rate: a scalar value that represents a discount rate that will be used in calculations. Can either be a scalar variable or entered in the expression. variable: a periodic numeric variable (usually represents a cash flow) discountdate: (optional) datetime or user entered date that specifies when NPV needs to be applied from. If not specified, the document's start date is used discountmethod: (optional) the discount method. The default method is Monthly, other possible methods are: Annual Start, Annual Mid, Annual End. donotdiscounthistoricalperiods (optional): boolean value that controls whether historical periods are discounted or not. Default value is false.

Examples:

1. NPV(rate1, cashflow) - calculate NPV for cashflow1 using the rate stored in variable rate1.

2. NPV("10", cashflow2, "12/31/2015", "Annual Start", "true") - calculate NPV for cashflow2 using constant rate, annual start discount method and discount historical periods.

Converts the supplied text to a date. If the optional format argument is supplied, the date will be parsed using this exact representation, otherwise the current regional settings will be used. Examples: PARSEDATE(“31 January 2010”), PARSEDATE(“01/31/2010”,“MM/dd/yyyy”).

Common format specifiers:

d day 1 - 31

dd day 01 - 31

M month 1 - 12

MM month 01 - 12

MMM abbreviated month name, e.g. Jan, Feb

MMMM full month name

yy year 00 - 99

yyyy 4-digit year

Simulates the type curve well approach. variable1 is a periodic variable which represents a time series curve profile, in volume per period. variable2 is a periodic variable which represents a drilling plan, in number of wells per period. Result: An analog style time series output in resultant volume.

Example: PRODUCTIONANALOG(variable1,variable1) where variable1 (in Mbbl) = 1,2,3,5,5,4,3,2,1 variable2 (in wells) = 2,2,2,3,3,1,1,0,0. The output is (in Mbbl) = 2,6,12,23,35,44,51,53,47.

Calculates the total value of a periodic variable for the given range. variable: periodic variable. start: range start year. end: range end year.

Example: If Var1=1,2,3,4,5 over a period 2010 to 2014. 1. Integer range parameters RANGE([Var1],1,3) = 9,9,9,9,9 2. Date range parameters RANGE([Var1],"1/1/2011","12/1/2013") = 9,9,9,9,9

Note: If the expression is assigned to a Scalar variable, the function will return only one value which is the sum of the given range values.